docs: dev note for workflow chaining#775
Conversation
|
Fern preview: https://nvidia-preview-pr-775.docs.buildwithfern.com/nemo/datadesigner
|
|
|
||
| In that shape, `quality_gate` is both a normal stage and a contract. Upstream work promises a schema. Downstream work consumes that schema. A reviewer, evaluator, dashboard, or cleanup script only has to preserve the contract. | ||
|
|
||
|  |
There was a problem hiding this comment.
This is GitHub's rendered diff resolving Fern's root-relative /assets/... path against github.com. The tracked image is valid and renders in the Fern preview, so I kept the established Fern asset path.
Signed-off-by: Andre Manoel <amanoel@nvidia.com>
Greptile SummaryThis PR adds a workflow chaining dev note and runnable document review gate recipe. The main changes are:
|
| Filename | Overview |
|---|---|
| docs/assets/recipes/workflow_chaining/document_review_gate.py | Adds the runnable review gate recipe and handles the main artifact reuse and non-positive record-count paths. |
| packages/data-designer-config/src/data_designer/config/run_config.py | Defines ResumeMode in the config package for public config-layer access. |
| packages/data-designer-config/src/data_designer/config/init.py | Adds ResumeMode to the config package lazy exports. |
| packages/data-designer-engine/src/data_designer/engine/storage/artifact_storage.py | Uses the config-layer ResumeMode while keeping the old module-level import name available. |
| packages/data-designer/src/data_designer/interface/init.py | Updates the interface lazy export target for ResumeMode. |
| packages/data-designer/tests/docs/test_document_review_gate_recipe.py | Adds tests for the new recipe flow and its key CLI/artifact edge cases. |
Reviews (2): Last reviewed commit: "docs: address workflow chaining feedback" | Re-trigger Greptile
|
Thanks for putting this together, @andreatgretel — this is a genuinely nice dev note, and the runnable recipe makes the workflow-chaining story concrete. SummaryThis is a docs + recipe PR: it adds the "Pause, Inspect, Resume" dev note, a headless FindingsSuggestions — Take it or leave it
What Looks Good
Notes
Structural Impact (graphify, 2.4s)Risk: LOW (localized change)
This confirms a localized, additive change with no god-node or cross-package blast radius — consistent with a docs + standalone-recipe PR that imports the public API surface without modifying it. VerdictShip it (with nits) — Only optional suggestions above; nothing blocking. Worth a quick reply to the two existing inline comments before merge, but the change itself is in good shape. This review was generated by an AI assistant. |
Signed-off-by: Andre Manoel <amanoel@nvidia.com>
|
Addressed the remaining actionable bot feedback:
Validation: 294 tests passed, Ruff passed, and Fern reported 0 errors with 1 existing warning. |

📋 Summary
Adds a dev note and runnable recipe for workflow chaining as a pause/inspect/resume control surface. The post focuses on what named stage boundaries enable, including human review, reusable intermediate artifacts, downstream resume, and future workflow shapes.
🔗 Related Issue
N/A
🔄 Changes
review_candidates, writes a reviewed artifact, and resumes downstream from that artifact.🧪 Testing
.venv/bin/ruff check ..venv/bin/ruff format --check ..venv/bin/pytest packages/data-designer/tests/docs/test_document_review_gate_recipe.pyenv npm_config_cache=/private/tmp/npm-cache-datadesigner make check-fern-docs(0 errors, 1 existing Fern warning)✅ Checklist